.. :validated: 3.1.0

Доступные точки входа для пользователей без дополнительных привилегий (ролей)
-----------------------------------------------------------------------------

Аннотация
~~~~~~~~~

Ниже приведен список точек входа, доступных пользователю со стандартной учетной записью. Основная часть открытых точек входа — это запросы типа GET, предназначенные для чтения данных без изменения состояния системы. В некоторых случаях запросы могут возвращать код успеха (200), но не содержать данных, что является нормальным поведением системы. В таблице :ref:`entry_points_table` также присутствуют запросы типа POST и PATCH, которые предназначены для операций, связанных с аутентификацией и операциями в личном кабинете пользователя ALD Pro.

Описание точек входа
~~~~~~~~~~~~~~~~~~~~

.. _entry_points_table:

.. list-table:: Описание точек входа
   :widths: 10 40 25 25
   :header-rows: 1
   :class: longtable

   * - Метод
     - ТВ
     - Описание
     - Ответ

   * - 
     - Аутентификация пользователя
     - 
     - 
   * - POST
     - /api/ds/login
     - Аутентификация пользователя: вход
     - Аутентификация
   * - POST
     - /api/ds/logout
     - Аутентификация пользователя: выход
     - Завершение сеанса
   * - GET
     - /api/ds/whoami
     - Аутентификация пользователя: получить данные о текущей сессии пользователя
     - Возвращает данные

   * - 
     - Конфигурация службы каталогов
     - 
     - 
   * - GET
     - /api/ds/dsserver/ schema/attributetypes
     - Конфигурация службы каталогов: Получить значения справочника типов данных атрибутов схемы
     - Возвращает данные

   * - 
     - Справочники
     - 
     - 
   * - GET
     - /api/ds/countries
     - Служба каталогов: получить значения справочника стран
     - Возвращает данные

   * - 
     - Пользователи
     - 
     - 
   * - GET
     - /api/ds/user-profile
     - Пользователи: Получить параметры текущего пользователя (Личный кабинет)
     - Возвращает данные
   * - PATCH
     - /api/ds/user-profile
     - Пользователи: Обновить параметры текущего пользователя (Личный кабинет)
     - Изменяет данные
   * - PATCH
     - /api/ds/user-profile/reset-password
     - Пользователи: Изменить пароль текущего пользователя (Личный кабинет)
     - Изменяет пароль
   * - GET
     - /api/ds/users/ {userName}/custom-attributes
     - Пользователи: Получить список дополнительных атрибутов пользователя
     - Возвращает данные
   * - GET
     - /api/ds/users
     - Пользователи: Получить список пользователей
     - Возвращает данные
   * - GET
     - /api/ds/users/ {userName}
     - Пользователи: Получить параметры пользователя
     - Возвращает данные
   * - GET
     - /api/ds/users/ {userName}/user-groups
     - Пользователи: Получить список групп пользователей, в которые входит пользователь
     - Возвращает данные
   * - GET
     - /api/ds/users/ {userName}/user-groups/indirect
     - Пользователи: Получить список групп пользователей, в которые косвенно входит пользователь
     - Возвращает данные
   * - GET
     - /api/ds/users/ {userName}/roles
     - Пользователи: Получить список ролей пользователя
     - Возвращает данные
   * - GET
     - /api/ds/users/ {userName}/roles/ indirect
     - Пользователи: Получить список ролей, в которые косвенно входит пользователь
     - Возвращает данные
   * - GET
     - /api/ds/users/ {userName}/ proxy_addresses
     - Пользователи: Получить перечень значений прокси адресов пользователя
     - Возвращает данные
   * - GET
     - /api/ds/preserved/ users/{userName}/ proxy_addresses
     - Пользователи: Получить перечень значений прокси адресов хранимого пользователя в корзине
     - Возвращает данные

   * - 
     - Группы пользователей
     - 
     - 
   * - GET
     - /api/ds/user-groups
     - Группы пользователей: Получить список групп пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}
     - Группы пользователей: Получить карточку группы пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}/ groups/child-group
     - Группы пользователей: Получить список групп в составе группы пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}/ groups/child-group/indirect
     - Группы пользователей: Получить группы, которые косвенно содержит группа пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}/ groups/parent-group
     - Группы пользователей: Получить список групп, в состав которых входит группа пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}/ groups/parent-group/indirect
     - Группы пользователей: Получить список групп, в состав которых косвенно входит группа пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}/ users
     - Группы пользователей: Получить список пользователей в составе группы пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}/ roles
     - Группы пользователей: Получить список ролей в составе группы пользователей
     - Возвращает данные
   * - GET
     - /api/ds/user-groups/ {userGroupName}/ roles/indirect
     - Группа пользователей: Получить список ролей, в которые косвенно входит группа пользователей
     - Возвращает данные

   * - 
     - Компьютеры
     - 
     - 
   * - GET
     - /api/ds/computers
     - Компьютеры: Получить список компьютеров
     - Возвращает данные
   * - GET
     - /api/ds/computers/ {computerName}
     - Компьютеры: Получить параметры компьютера
     - Возвращает данные
   * - GET
     - /api/ds/computers/ {computerName}/ groups
     - Компьютеры: Получить группы компьютеров, в которые входит компьютер
     - Возвращает данные
   * - GET
     - /api/ds/computers/ {computerName}/ groups/indirect
     - Компьютеры: Получить группы компьютеров, в которые косвенно входит компьютер
     - Возвращает данные

   * - 
     - Группы компьютеров
     - 
     - 
   * - GET
     - /api/ds/computer-groups
     - Группы компьютеров: Получить список групп компьютеров
     - Возвращает данные
   * - GET
     - /api/ds/computer-groups/ {computerGroupName}
     - Группы компьютеров: Получить параметры группы компьютеров
     - Возвращает данные
   * - GET
     - /api/ds/computer-groups/ {computerGroupName}/ computers
     - Группы компьютеров: Получить компьютеры в составе группы
     - Возвращает данные
   * - GET
     - /api/ds/computer-groups/ {computerGroupName}/ groups/child-groups
     - Группы компьютеров: Получить группы, которые содержит группа компьютеров
     - Возвращает данные
   * - GET
     - /api/ds/computer-groups/ {computerGroupName}/ groups/child-groups/indirect
     - Группы компьютеров: Получить группы, которые косвенно содержит группа компьютеров
     - Возвращает данные
   * - GET
     - /api/ds/computer-groups/ {computerGroupName}/ groups/parent-groups
     - Группы компьютеров: Получить группы, в которых состоит группа компьютеров
     - Возвращает данные

   * - 
     - Организационные подразделения
     - 
     - 
   * - GET
     - /api/ds/organizational-units
     - Организационные подразделения: Получить список организационных подразделений
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ catalogue/children
     - Организационные подразделения: Получить корневые объекты дерева каталога. Переход между уровнями дерева каталога организационных подразделений
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ catalogue/parent-tree
     - Организационные подразделения: Возврат в выбранный объект каталога после его конфигурации
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ catalogue/search
     - Организационные подразделения: Поиск по дереву каталога организационных подразделений
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ {organizationalUnit DistinguishedName}
     - Организационные подразделения: Получить параметры организационного подразделения
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ {organizationalUnit DistinguishedName}/ organizational-units
     - Организационные подразделения: Получить список дочерних организаций подразделения
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ {organizationalUnit DistinguishedName}/ computers-groups
     - Организационные подразделения: Получить группы компьютеров организационного подразделения
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ {organizationalUnit DistinguishedName}/ computers
     - Организационные подразделения: Получить список компьютеров организационного подразделения
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ {organizationalUnit DistinguishedName}/ group-policies
     - Организационные подразделения: Получить список объектов групповых политик подразделения
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ {organizationalUnit DistinguishedName}/ users-groups
     - Организационные подразделения: Получить список групп пользователей организационного подразделения
     - Возвращает данные
   * - GET
     - /api/ds/organizational-units/ {organizationalUnit DistinguishedName}/ users
     - Организационные подразделения: Получить список пользователей организационного подразделения
     - Возвращает данные
